@casual-simulation/aux-common

AUX Common

A library that contains common operations needed to modify and understand AUX files.

Installation

$ npm install @casual-simulation/aux-common

Usage

Calculate a formula for some bots

import {
    createBot,
    createCalculationContext,
    calculateFormulaValue,
} from '@casual-simulation/aux-common';

const file1 = createBot('test1', {
    quantity: 10,
});
const file2 = createBot('test2', {
    quantity: 5,
});
const file3 = createBot('test3', {
    quantity: 5,
});

const context = createCalculationContext([file1, file2, file3]);

const formula = '=math.sum(getBotTagValues("#quantity"))';
const result = calculateFormulaValue(context, formula);

console.log(result);

// Outputs:
// 20

Calculate events for an action script

import {
    createBot,
    createCalculationContext,
    calculateFormulaEvents,
} from '@casual-simulation/aux-common';

const state = {
    test1: createBot('test1', {
        quantity: 10,
    }),
    test2: createBot('test2', {
        quantity: 5,
    }),
    test3: createBot('test3', {
        quantity: 5,
    }),
};

const formula = `
    let total = math.sum(getBotTagValues("#quantity"));
    player.toast("The total is " + total);
`;
const events = calculateFormulaEvents(state, formula);

for (let event of events) {
    if (event.type === 'local') {
        if (event.name === 'show_toast') {
            console.log('[Toast]', event.message);
        }
    }
}

// Outputs:
// [Toast] The total is 5

Changelog

V2.0.36

Date: 2/4/2022

:rocket: Improvements

• Added global search to the systemPortal.
  • Useful for finding a word or phrase in the tags of all the bots in an inst.
  • For example, you can find all the places where a shout occurrs by typing "shout" into the search box.
  • Can be accessed by using Ctrl+Shift+F while the systemPortal is open or by selecting the eyeglass icon on the left side of the screen.
• Added the ability to use a video camera feed as the portal background.
  • You can enable this feature by setting portalBackgroundAddress to casualos://camera-feed.
  • It also supports specifying the rear or front facing cameras with casualos://camera-feed/rear and casualos://camera-feed/front.

:bug: Bug Fixes

• Fixed an issue with custom apps where HTML changes would stop propagating if an element was added to its own parent.
  • This could happen via using the HTML document API like:

    // in @onSetupApp
    const parent = that.document.createElement('div');
    const child = that.document.createElement('span');
    parent.appendChild(child);
    parent.appendChild(child); // This would cause the issue
    

  • Alternatively, it could happen when using os.compileApp().
    • For efficiency, os.compileApp() uses a change detection algorithm to limit the number of HTML elements it needs to create.
    • In some cases, it saw that it could reuse an HTML element by moving it and this happened to trigger the bug in the system that records these changes.